home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / dskut / sutil282.zip / SUTIL.DOC < prev    next >
Text File  |  1992-11-05  |  25KB  |  525 lines
  1. ------------------------------------------------------------------------------
  2. 11/05/92                   Supreme Utility              All Rights Reserved
  3. Copyright (c) 1990-92 by SupremeSoft        Integrated Copy/Move/Delete/Rename
  4. ------------------------------------------------------------------------------
  5.                             Version 2.82
  6.  
  7.  
  8.         Supreme Utility is a command line based program which allows you to
  9. Copy, Delete, Rename and Move files all in one operation. Imagine begin able
  10. to delete all your BAK files while at the same time copying all your DOC
  11. files to your word processing directory!
  12.  
  13.         Supreme Utility can work locally or globally. That is, it can
  14. manipulate files in only the current directory, or on the entire disk.
  15. Naturally you are in complete control at all times, unless you choose not to
  16. be. Here is the calling syntax:     ( [] indicates optional items)
  17.  
  18. SUtil [-|/][Gflags] [-|/][mdcrx] filelist [,filelist] [-|/][flags] [@filen] ..
  19.  
  20.  
  21. The ".." indicates that you may include more combinations of commands/flags
  22. in the same form as specified earlier.
  23.  
  24.  
  25.   Where:         m     =  move these files
  26.                  d     =  delete these files
  27.                  c     =  copy these files
  28.                  r     =  rename these files
  29.                  x     =  exclude these files     (See excluding files below)
  30.  
  31.   Flags are:     h     =  use hidden/system files as well   (Off by default)
  32.                  g     =  work on the entire disk           (Off by default)
  33.                  p     =  disable prompting                 (On  by default)
  34.                  q     =  quiet mode                        (Off by default)
  35.                  e     =  check exclude list                (Default depends)
  36.                  s     =  scan subdirectories               (Off by default)
  37.                  k     =  check free disk space             (Off by default)
  38.  
  39.   @filen:        Indicates a file consisting of operations to be read in.
  40.                  (filen = any valid DOS filename, including leading path)
  41.  
  42. A filelist consists of a list of filenames, as many as you want. If you do
  43. not explicitly specify a second filelist using the "," separator, the last
  44. filename in the file list is taken as the target (if appropriate).  (See
  45. "Oddities" below)
  46.  
  47.   [-|/]  indicates you may use either a "-" or a "/". These are commonly
  48. referred to as the "switch" characters.
  49.  
  50.   Each operation (m,d,r, c, or x) MUST be preceded by a switch, and each flag
  51. (H, G, P, Q, E, S, K) MUST be preceded by a switch.
  52.  
  53.   Case is insignificant, i.e., M = m, C = c, H=h, etc.
  54.  
  55.   GFlags are flags which are set as defaults for all operations. If you
  56. specify any flags after certain commands, they will then override the default
  57. flags set in GFlags for that operation only.
  58.  
  59.   Flags may appear anywhere on the command line, except between filename
  60. lists. If you override a default flag, it will return to its default after
  61. the operation completes. Use GFlags to set/reset defaults.
  62.  
  63.   Quiet mode will turn off the file exists warning, thereby proceeding with
  64. the operation and overwriting any existing files.
  65.  
  66.   If a "," is included between filename lists, the filenames FOLLOWING the
  67. "," will be used as new target names. (See below for further information)
  68.  
  69.   Filenames may consist of a leading path, and any DOS wildcards.
  70.   NOTE!: A DOS wildcard of *?????, that is a star (*) anywhere in the
  71.          wildcard, will match ALL files, regardless of what follows, or
  72.          precedes the * indicator. See ODDITIES for more information.
  73.  
  74.   Each command may have any number of filenames following it.
  75.  
  76.   You may use multiple @filen specifications if you wish.
  77.  
  78.   Ctrl-Break/Ctrl-C will abort the program.
  79.  
  80.   DOS ERRORLEVEL is set for batch file testing. The following are the
  81. possible return codes:
  82.  
  83.              0    Success
  84.              1    Help was activated  (no command line)
  85.              2    Fatal error, program aborted
  86.              3    Out of memory error
  87.  
  88.   Use the DOS environment variable SUTIL to set initial operations. The syntax
  89. is:   SET SUTIL = [operations]
  90.  
  91.   If you choose the Sub-directory option, Supreme Utility will scan all
  92. subdirectories of the CURRENT directory for matching files. Any leading path
  93. identifiers are ignored. If you issue the Global option, then this option will
  94. be ignored.
  95.  
  96.   Choosing the /K switch will slow down operations somewhat at the start, but
  97. can save time in the long run since SUtil will not attempt the operation if
  98. there is not enough disk space. If you do NOT choose this switch and there
  99. is NOT enough disk space, SUtil will only abort after it detects the error.
  100.  
  101.   When using the /K switch and performing operations on the same drive,
  102. SUtil is smart enough to determine if there is a need to check the free
  103. disk space. If there is not, then it will not do so. This is why it is wise
  104. to make the /K switch part of your GFlag setting.
  105. -----------------------------------------------------------------------------
  106. Moving files:
  107.  
  108.         To move files, use the -m or /m option and specify the files to be
  109. moved. You do not have to specify the target directory as long as the files
  110. to be moved are not in the current directory. If you leave prompting active,
  111. you will be asked to confirm each move.
  112.  
  113.         The target directory cannot be the current directory, but can be
  114. anything else, including another drive/directory combination. The files will
  115. be moved extremely quickly, though drive to drive moves will take longer
  116. depending on the drive types.
  117.  
  118.         You may also specify that the files be named differently by
  119. specifying a path/filename combination. See Example5.
  120.  
  121.         The date/time stamp on the source file will be preserved on the
  122. target file. In other words, the date/time stamp on the target file will
  123. be the same as on the source file.
  124.  
  125. Example1:  SUtil /m test.bak test.doc \temp /p
  126. Does    :  Moves "test.bak" and "test.doc" to the "\temp\" directory, and
  127.            does not prompt you for verification.
  128.  
  129. Example2:  SUtil -m \temp\*.bak \docs\test.doc \tt.doc
  130. Does    :  Moves all BAK files from the "\temp\" directory, "test.doc"
  131.            from the "\docs\" directory, "tt.doc" from the root to the CURRENT
  132.            directory.
  133.  
  134. Example3:  SUtil /m *.bak \junk\ /h /g /q
  135. Does    :  Moves all BAK files on the ENTIRE disk to the "\junk\" directory,
  136.            and this will also move BAK files which are marked as
  137.            Hidden/System. In addition, if any of the files exist in the
  138.            target directory, they are overwritten automatically.
  139.  
  140. Example4: SUtil -m \temp\*.bak /g
  141. Does    : Will move all BAK files from the "\temp\" directory to the CURRENT
  142.           directory, and will then attempt to find any further "\temp\*.bak"
  143.           files on the disk. Since there will be no more, nothing further is
  144.           done.
  145.  
  146. Example5: SUtil -m myfile.tst hey.me,\test\junk.tst \test\hey.tst /p/h
  147. Does    : Will move "myfile.tst" to "\test\junk.tst" and "hey.me" to
  148.           "\test\hey.tst". No prompting is done, and hidden files are moved.
  149.  
  150. Example6: Sutil -m *.pas, *.bak /p
  151. Does    : Moves all PAS files in the current directory to BAK files in the
  152.           current directory. You are not prompted.
  153.           (This is essentially the same as a rename)
  154.  
  155.         Remember, you cannot move files in the current directory to the
  156. current directory unless you specify a new target name. The program will
  157. issue an error message if you attempt to move into the same
  158. directory using the same name.
  159. -----------------------------------------------------------------------------
  160. Deleting Files:
  161.  
  162.         To Delete files use the -d or /d option. If you leave prompting on,
  163. you will be asked to confirm each delete.
  164.  
  165. Example1: SUtil -d *.bak *.txt /p
  166. Does    : Deletes all BAK files and all TXT files in the current directory,
  167.           but does not ask you to verify the delete(s).
  168.  
  169. Example2: SUtil /d *.bak /g /p
  170. Does    : Deletes all BAK files on the entire disk. Even though prompting is
  171.           off, you will be as